home *** CD-ROM | disk | FTP | other *** search
/ SGI Freeware 2002 November / SGI Freeware 2002 November - Disc 2.iso / dist / fw_hylafax.idb / usr / freeware / catman / u_man / cat1 / sendfax.Z / sendfax
Text File  |  2002-07-08  |  36KB  |  708 lines

  1. SENDFAX(1)                           SENDFAX(1)
  2.  
  3.  
  4.  
  5. NNAAMMEE
  6.        sendfax - submit    a facsimile job    for transmission
  7.  
  8. SSYYNNOOPPSSIISS
  9.        sseennddffaaxx [ _o_p_t_i_o_n_s ] [ _f_i_l_e_s...  ]
  10.  
  11. DDEESSCCRRIIPPTTIIOONN
  12.        _s_e_n_d_f_a_x     submits   one    or  more  facsimile  transmission
  13.        requests    to a _H_y_l_a_F_A_X facsimile server.    Requests are nor
  14.        mally  processed     immediately,  although     they may also be
  15.        queued for transmission at a later  time     using    a  syntax
  16.        identical  to  the  _a_t(1)  command.   For each job that is
  17.        queued, _s_e_n_d_f_a_x prints a    _j_o_b _i_d_e_n_t_i_f_i_e_r and  a  _j_o_b  _g_r_o_u_p
  18.        _i_d_e_n_t_i_f_i_e_r  on  the  standard output.  A    job identifier is
  19.        the token by which jobs are identified within _H_y_l_a_F_A_X; job
  20.        group identifiers are used to reference a set of    jobs that
  21.        have been submitted at the same time.  Job and  job  group
  22.        identifiers  can     be  supplied  to the _f_a_x_r_m(1) command to
  23.        remove the jobs or to the _f_a_x_a_l_t_e_r(1) command to    alter job
  24.        parameters.
  25.  
  26.        Facsimile  are made from    the concatenation of a cover page
  27.        (see below) and one or more files specified on the command
  28.        line.  If no files are supplied on the command line, _s_e_n_d_
  29.        _f_a_x will    read data from the standard input unless  polling
  30.        is  requested.  Cover pages are distinguished for the pur
  31.        pose of generating ``_c_o_n_t_i_n_u_a_t_i_o_n  _c_o_v_e_r     _p_a_g_e_s''  on  the
  32.        server;    these  are  makeup cover pages that are    automati
  33.        cally generated if a job    fails after sending the     original
  34.        user-specified cover page.
  35.  
  36.        _s_e_n_d_f_a_x    passes    POSTSCRIPT  and     TIFF documents    directly
  37.        through to the fax server for transmission,  and     attempts
  38.        to  convert  other  file     formats  to either POSTSCRIPT or
  39.        TIFF.  In normal    operation _s_e_n_d_f_a_x automatically     converts
  40.        ASCII-text,  _t_r_o_f_f(1)  output,  Portable     Document  Format
  41.        (PDF), and Silicon Graphics format  images  for    transmis
  42.        sion.   Support for other file formats can be easily added
  43.        through an extensible file typing and conversion    facility;
  44.        see _t_y_p_e_r_u_l_e_s(${MANNUM4_5}).  Note that since TIFF Class    F
  45.        documents are processed directly    it is simple to    forward    a
  46.        received    facsimile.
  47.  
  48.        By  default  _s_e_n_d_f_a_x  will  generate a cover page for each
  49.        facsimile that is to be transmitted.  This cover     page  is
  50.        created    by the ancillary _f_a_x_c_o_v_e_r(1) program using infor
  51.        mation deduced by _s_e_n_d_f_a_x and by    information  supplied  on
  52.        the  command line.  Automatic cover page    generation may be
  53.        suppressed with the --nn option.
  54.  
  55.        In addition to sending documents, _s_e_n_d_f_a_x can be     used  to
  56.        poll  a remote facsimile    machine    to retrieve waiting docu
  57.        ments.  If the --pp option    is specified, a     polling  request
  58.        will  be    submitted to each destination.    If a poll request
  59.        is made in conjunction with the transmission of documents,
  60.        the  poll  request will take place after    the documents are
  61.        transmitted.  Documents retrieved by polling are     returned
  62.        to the requestor    by electronic mail and may be viewed with
  63.        a suitable viewer program.
  64.  
  65.        One or more destinations    must be    specified on the  command
  66.        line  using  the     --dd option.  A destination is the dialing
  67.        string to use to    contact    the remote  fax     machine.   Phone
  68.        numbers    may include non-alphanumeric characters    for read
  69.        ability--only alphanumerics  and     ``+''    (for  denoting    a
  70.        country    code)  are significant in placing a call.  Alpha
  71.        betic characters    are automatically mapped to their numeric
  72.        key equivalents:    ``abcABC'' to ``2'', ``defDEF''    to ``3'',
  73.        etc.  Dialing prefixes, such as    ``1''  and  ``011''  (for
  74.        long  distance  calling    in the United States) need not be
  75.        included    if an unambigous number    is  specified.     Examples
  76.        of unambiguous phone numbers are:
  77.           +31.77.594.131      _t_o _c_a_l_l _t_h_e _N_e_t_h_e_r_l_a_n_d_s
  78.           +14159657824      _t_o _c_a_l_l _C_a_l_i_f_o_r_n_i_a
  79.           9657824          _t_o _m_a_k_e _a _l_o_c_a_l _c_a_l_l
  80.           1-215-356-1666      _t_o _c_a_l_l _P_e_n_n_s_y_l_v_a_n_i_a _f_r_o_m _w_i_t_h_i_n _t_h_e _U_S
  81.        Non-numeric strings, such as ``*70'' (to    defeat call wait
  82.        ing), may be included in     the  destination  phone  number.
  83.        Whether    or  not    they are stripped from the string used to
  84.        dial the    destination fax    machine    is dependent on    the dial
  85.        string  rules  configured  for  use  on    the  server; c.f.
  86.        _h_y_l_a_f_a_x_-_c_o_n_f_i_g(${MANNUM4_5}) and     _d_i_a_l_r_u_l_e_s(${MANNUM4_5}).
  87.  
  88.        A  destination  may  also be specified as _u_s_e_r_@_f_a_x_-_n_u_m_b_e_r.
  89.        In this case the    _u_s_e_r string will be passed to _f_a_x_c_o_v_e_r as
  90.        the identity of the recipient.  Note that multi-word names
  91.        must be enclosed    in quote marks;    for example,  ``Sam  Lef
  92.        fler@+1.415.555.1212''.
  93.  
  94.        The  order  of options on the command line is significant.
  95.        Each fax    to be transmitted is assigned the  current  value
  96.        of  parameters specified    on the command line; e.g. whether
  97.        or not to generate a cover page.     This means that  options
  98.        that  specify parameters    for a particular destination must
  99.        precede the dialstring specified    with the --dd option.   For
  100.        example,
  101.  
  102.           sendfax -n -d 5551212 /etc/passwd
  103.  
  104.        submits a fax to    5551212    that has no cover page while
  105.  
  106.           sendfax -d 5551212 -n /etc/passwd
  107.  
  108.        submits    the same fax but with the default cover    page han
  109.        dling.  Note also that parameter    values persist across  --dd
  110.        options so the following
  111.  
  112.           sendfax -n -d 5551212 -d 5551313 /etc/network
  113.  
  114.        submits two facsimile, both of which have no cover page.
  115.  
  116. OOPPTTIIOONNSS
  117.        --11       Transmit facsimile documents    using 1-D MR com
  118.            pression.  By default  _H_y_l_a_F_A_X  will     use  the
  119.            optimal  compression     scheme     supported by the
  120.            transmitting     modem    and  receiving    facsimile
  121.            device.
  122.  
  123.        --22       Transmit facsimile documents    using 2-D MR com
  124.            pression, if     possible.   By     default  _H_y_l_a_F_A_X
  125.            will     use  the optimal compression scheme sup
  126.            ported by the transmitting modem and    receiving
  127.            facsimile device.
  128.  
  129.        --aa _t_i_m_e       Schedule   transmission  up    to  one     year  in
  130.            advance at the indicated _t_i_m_e.  _T_i_m_e    is speci
  131.            fied    in the format: ``[HH:MM    [AM|PM]|now] [+    N
  132.            _p_e_r_i_o_d | _m_o_n_t_h DD | _d_a_y_o_f_w_e_e_k ] where  _m_o_n_t_h
  133.            can     be   Jan(uary),   Feb(ruary),     Mar(ch),
  134.            Apr(il),  May,   Jun(e),   Jul(y),    Aug(ust),
  135.            Sep(tember),       Oct(ober),     Nov(ember),   or
  136.            Dec(ember); _p_e_r_i_o_d can be minute(s),     hour(s),
  137.            day(s), week(s), or month(s); _d_a_y_o_f_w_e_e_k can be
  138.            Mon(day), Tue(sday),    Wed(nesday),  Thu(rsday),
  139.            Fri(day),  Sat(urday),  Sun(day); e.g. ``now    +
  140.            30 minutes to schedule transmission 30  min
  141.            utes     in  the future.  Trailing information in
  142.            the _t_i_m_e field (such    as YYYY) is ignored.   By
  143.            default, _s_e_n_d_f_a_x schedules facsimile    for imme
  144.            diate delivery.  Time should    be given  in  the
  145.            user's local    time.
  146.  
  147.        --bb _s_p_e_e_d       Transmit  facsimile    documents  using  a  sig
  148.            nalling rate    that  is  constrained  to  be  at
  149.            least  _s_p_e_e_d     bits/second.    If  the    specified
  150.            speed is greater than the  transmitting  modem
  151.            or  receiver     is  capable of, it is reduced to
  152.            the highest possible    speed both  devices  sup
  153.            port.  If a negotiated signalling rate greater
  154.            than    or equal to _s_p_e_e_d  cannot  be  negotiated
  155.            then    the job    is aborted.  Possible speeds are:
  156.            2400, 4800, 7200, 9600, 12000, and 14400.   By
  157.            default  _H_y_l_a_F_A_X will use the fastest possible
  158.            rate    supported by the transmitting  modem  and
  159.            receiving facsimile device.
  160.  
  161.        --BB _s_p_e_e_d       Try    to transmit facsimile documents    using the
  162.            desired signalling rate.  Possible speeds are:
  163.            2400,  4800,    7200, 9600, 12000, and 14400.  If
  164.            the specified speed is greater than the trans
  165.            mitting modem or receiver is    capable    of, it is
  166.            reduced to the  highest  possible  speed  both
  167.            devices  support.  By default _H_y_l_a_F_A_X will use
  168.            the fastest possible     rate  supported  by  the
  169.            transmitting     modem    and  receiving    facsimile
  170.            device (unless restricted by    other server con
  171.            figuration);    this option can    be used    to reduce
  172.            the speed.  Note that international calls  are
  173.            frequently  more  reliable  when transmissions
  174.            are restricted to 9600 bits/second.
  175.  
  176.        --cc _c_o_m_m_e_n_t_s Pass    _c_o_m_m_e_n_t_s to the    _f_a_x_c_o_v_e_r(1)  program  for
  177.            inclusion  in the comments field of any gener
  178.            ated    cover page.
  179.  
  180.        --CC _f_i_l_e       Pass    _f_i_l_e to    the _f_a_x_c_o_v_e_r(1)    program     for  use
  181.            as the cover    page template.
  182.  
  183.        --DD       Enable  notification     by  electronic    mail when
  184.            the facsimile has been delivered.  By  default
  185.            _H_y_l_a_F_A_X  will  notify  the  submitter  only if
  186.            there is a problem with a job.
  187.  
  188.        --dd _d_e_s_t_i_n_a_t_i_o_n
  189.            Create a job    to transmit  the  supplied  docu
  190.            ments  to a facsimile machine at the    indicated
  191.            _d_e_s_t_i_n_a_t_i_o_n.     If the     _d_e_s_t_i_n_a_t_i_o_n  is  of  the
  192.            form    ``_u_s_e_r@_p_h_o_n_e_-_n_u_m_b_e_r'' then any cover page
  193.            will    show _u_s_e_r as the intended receipient.
  194.  
  195.        --EE       Disable use of the Error Correction Mode (ECM)
  196.            when      transmitting    page  data.   By  default
  197.            _H_y_l_a_F_A_X will    attempt    to use ECM when    both  the
  198.            trasmitting modem and receiving device support
  199.            it.    Note that international    calls  are  some
  200.            times  faster  when    ECM  is    disabled.  Beware
  201.            also    that some modems and/or    facsimile devices
  202.            do  not  properly implement ECM causing trans
  203.            mission failures.
  204.  
  205.        --ff _f_r_o_m       Use _f_r_o_m as    the  identity  of  the    facsimile
  206.            sender.  Otherwise the sender is the    user that
  207.            invoked _s_e_n_d_f_a_x.  The  sender  is  an  account
  208.            name     to  which  the     _H_y_l_a_F_A_X  software should
  209.            direct notification messages.  The _f_r_o_m  iden
  210.            tity     may  be a fullblown ``From:'' line, e.g.
  211.            e.g.      ``Joe       Blow       <joe@foo.com>''    and
  212.            ``joe@foo.com (Joe Blow)'' are acceptable.  If
  213.            no host-part    is specified in    the  _f_r_o_m  string
  214.            the    local  hostname     is used.  This    option is
  215.            useful when _s_e_n_d_f_a_x is invoked  on  behalf  of
  216.            another user, such as in the    implementation of
  217.            an electronic mail to fax gateway.
  218.  
  219.        --FF _f_o_r_m_a_t   Use the  specified  _f_o_r_m_a_t  when  imaging  tag
  220.            lines on outgoing pages.  Consult the descrip
  221.            tion     of  the   TTaaggLLiinneeFFoorrmmaatt   parameter   in
  222.            _h_y_l_a_f_a_x_-_c_o_n_f_i_g(${MANNUM4_5})     for  an explana
  223.            tion    of how to construct a format string.
  224.  
  225.            _N_o_t_e    _t_h_a_t _m_a_n_y  _l_o_c_a_l_e_s  _r_e_q_u_i_r_e  _t_h_a_t  _p_r_o_p_e_r
  226.            _i_d_e_n_t_i_f_i_c_a_t_i_o_n  _a_p_p_e_a_r _o_n _a_l_l _t_r_a_n_s_m_i_t_t_e_d _f_a_c_
  227.            _s_i_m_i_l_e_; _w_h_e_n    _u_s_i_n_g _t_h_i_s  _f_a_c_i_l_i_t_y  _o_n_e  _s_h_o_u_l_d
  228.            _a_l_w_a_y_s  _i_n_c_l_u_d_e  _p_r_o_p_e_r _i_d_e_n_t_i_f_i_c_a_t_i_o_n _(_e_._g_.    _a
  229.            _p_h_o_n_e _n_u_m_b_e_r_) _i_n _t_h_e    _i_m_a_g_e_d _t_a_g_l_i_n_e_s_.
  230.  
  231.        --hh [_m_o_d_e_m@]_h_o_s_t[_:_p_o_r_t]
  232.            Force the jobs to be    processed on  a     specific
  233.            _h_o_s_t      and,    optionally,  using  a  particular
  234.            _m_o_d_e_m.  The _h_o_s_t may    be either a symbolic name
  235.            or a    network    address.  If no    --hh option is sup
  236.            plied, _s_e_n_d_f_a_x uses the FAXSERVER  environment
  237.            variable  to     identify  the    _H_y_l_a_F_A_X    server to
  238.            which the jobs  should  be  directed.   If  no
  239.            server  is  specified then _s_e_n_d_f_a_x attempts to
  240.            contact a server on the  local  host.   If  no
  241.            modem  is specified,    the job    will be    submitted
  242.            to any available modem.
  243.  
  244.        --ii _i_d_e_n_t_i_f_i_e_r
  245.            Use the _i_d_e_n_t_i_f_i_e_r string in    any  notification
  246.            messages  instead  of the usual job identifier
  247.            number.  This option    is  useful  for     applica
  248.            tions  that    cross reference    notification mes
  249.            sages against job submissions.
  250.  
  251.        --II _t_i_m_e       If a    job must be requeued because of    a  commu
  252.            nication  failure schedule the retry    according
  253.            to the specified _t_i_m_e.   Times  are    given  in
  254.            seconds.   Minutes,    hours,    and  days  can be
  255.            specified with ``_m_i_n'', ``_h_o_u_r'', and  ``_d_a_y''
  256.            suffixes,  respectively.   By  default _H_y_l_a_F_A_X
  257.            reschedules jobs using retry    times that depend
  258.            on  the  manner  in which the job failed; this
  259.            interface permits  a     user  to  override  this
  260.            algorithm  and  specify  a  single fixed retry
  261.            time    for all    communication failures.
  262.  
  263.        --kk _t_i_m_e       Kill    the job    if it does not    complete  in  the
  264.            indicated  _t_i_m_e.   The  _t_i_m_e    is specifed using
  265.            notation identical to  the  --aa  option.   Note
  266.            that     the  _t_i_m_e is relative to the time of the
  267.            initial time-to-send.  The default  kill  time
  268.            is  ``now  +     3  hours'' (three hours from the
  269.            time    the job    is first  processed).    To  retry
  270.            for an hour,    ``now +1 hour''    could be used.
  271.  
  272.        --ll       Transmit  the  facsimile at a vertical resolu
  273.            tion    of 98 lines/inch; otherwise known as  _l_o_w
  274.            _r_e_s_o_l_u_t_i_o_n.
  275.  
  276.        --mm       Transmit  the  facsimile at a vertical resolu
  277.            tion    of 196    lines/inch;  otherwise    known  as
  278.            _m_e_d_i_u_m _r_e_s_o_l_u_t_i_o_n or    _f_i_n_e _m_o_d_e.
  279.  
  280.        --MM _m_s_t       Transmit  facsimile documents using the speci
  281.            fied    minimum    scanline  time.      Possible  times
  282.            are:     0ms,  5ms,  10ms2,  10ms,  20ms2,  20ms,
  283.            40ms2, and 40ms.  If     the  specified     time  is
  284.            less     than  the transmitting    modem or receiver
  285.            is capable of, it is    increased to  the  lowest
  286.            possible   time   both  devices  support.   By
  287.            default _H_y_l_a_F_A_X will    use the     lowest     possible
  288.            time     supported  by the transmitting    modem and
  289.            receiving facsimile device (unless  restricted
  290.            by  other  server configuration).  This option
  291.            is mostly useful for    debugging.
  292.  
  293.        --nn       Suppress the    automatic generation of     a  cover
  294.            page     for  subsequent  facsimile.   Note  that
  295.            polling requests do not receive a  cover  page
  296.            unless they are combined with the transmission
  297.            of one or more files.
  298.  
  299.        --NN       Do not notify the sender  by     electronic  mail
  300.            when     the  facsimile     has  been  delivered  or
  301.            requeued.
  302.  
  303.        --pp       Poll    each destination for any available  docu
  304.            ments.   If    a  poll     request is made together
  305.            with    document transmission, the poll    operation
  306.            is  done  after the documents are transmitted.
  307.            Documents received by polling are returned  to
  308.            the sender by electronic mail.
  309.  
  310.        --PP _p_r_i_o_r_i_t_y Assign  the    specified  scheduling _p_r_i_o_r_i_t_y to
  311.            subsequent jobs.  A    priority  is  an  integer
  312.            value  in  the  range  [0-255].   Lower values
  313.            result  in  higher  priority     processing.   By
  314.            default,  each job is assigned 127 for an ini
  315.            tial    scheduling priority.  If a job's priority
  316.            is greater than bulk    faxes then the job's pri
  317.            ority is raised (numerically    lowered) for each
  318.            failed  attempt to transmit so that retransmit
  319.            attempts are    done  ahead  of     newly    submitted
  320.            jobs.   In the case of bulk faxes (numerically
  321.            higher than 190), then the job's  priority  is
  322.            lowered  (numerically  raised) for each failed
  323.            attempt to transmit so that the whole  of  the
  324.            bulk-queued    jobs will be attempted before any
  325.            are retried.     The _p_r_i_o_r_i_t_y may also be  speci
  326.            fied     as  one of the    following symbolic names:
  327.            _d_e_f_a_u_l_t or _n_o_r_m_a_l (127), _b_u_l_k or  _j_u_n_k  (191),
  328.            _h_i_g_h    (63).
  329.  
  330.        --RR       Enable  notification     by  electronic    mail when
  331.            the facsimile has been delivered and     when  it
  332.            is  requeued     for  retransmission.  By default
  333.            _H_y_l_a_F_A_X will     notify     the  submitter     only  if
  334.            there is a problem with a job.
  335.  
  336.        --rr _r_e_g_a_r_d_i_n_g
  337.            Pass     _r_e_g_a_r_d_i_n_g  to the _f_a_x_c_o_v_e_r(1) program as
  338.            the value of    the ``Re:'' field of  any  gener
  339.            ated    cover page.
  340.  
  341.        --ss _s_i_z_e       Set    the  page size to use for the transmitted
  342.            facsimile.  Facsimile are normally imaged with
  343.            a  system-default  page  size (usually letter-
  344.            size    pages, 8.5" by 11", for     sites    in  North
  345.            America).   Alternate page sizes are    specified
  346.            symbolically    using either the name or abbrevi
  347.            ation  of  an  entry     in  the _p_a_g_e_s_i_z_e_s(${MAN
  348.            NUM4_5}) database; e.g.  _a_3 (ISO A3), _a_4  (ISO
  349.            A4),     _a_5  (ISO  A5),    _a_6 (ISO    A6), _b_4    (ISO B4),
  350.            _n_a_-_l_e_t (North American Letter), _u_s_-_l_e_g (Ameri
  351.            can    Legal),     _u_s_-_l_e_d    (American Ledger), _u_s_-_e_x_e
  352.            (American Executive),  _j_p_-_l_e_t  (Japanese  Let
  353.            ter),  and  _j_p_-_l_e_g  (Japanese Legal).  Compar
  354.            isons are case-insensitive and any match of    a
  355.            substring of    the full page-size name    is suffi
  356.            cient; e.g. ``legal'' would    match  ``American
  357.            Legal''.
  358.  
  359.            Note     that  it may not be permissible to image
  360.            into    the full page area; the    guaranteed repro
  361.            ducible  area  for  a page is typically inset.
  362.            Also, note that while arbitrary page    sizes can
  363.            be  specified  through the page size    database,
  364.            only    a limited set of page dimensions are sup
  365.            ported  by  the  Group  3  facsimile    protocol.
  366.            Thus    if an odd-size facsimile is submitted for
  367.            transmission     it may    not be possible    to deter
  368.            mine    if it can be sent until     the  fax  server
  369.            establishes communication with the remote fac
  370.            simile machine.
  371.  
  372.        --tt _t_r_i_e_s       Make    no more    than _t_r_i_e_s attempts to    send  the
  373.            facsimile.  By default, _H_y_l_a_F_A_X will    terminate
  374.            a job if: 3 consecutive  attempts  to  send    a
  375.            particular    page  fail,  or     it  appears  the
  376.            receiver is not a facsimile    machine.   Other
  377.            wise     _H_y_l_a_F_A_X places    no limit on the    _n_u_m_b_e_r of
  378.            attempts to send a facsimile,  instead  termi
  379.            nating  a  job if it    is not completed within    a
  380.            _k_i_l_l    _t_i_m_e timeout interval.    Note that  a  try
  381.            is  a call in which carrier is established and
  382.            the facsimile protocol is commenced;     this  is
  383.            contrasted with a call attempt that might have
  384.            failed because the line was busy.
  385.  
  386.        --TT _m_a_x_d_i_a_l_s Make    no more    than _m_a_x_d_i_a_l_s calls in attempting
  387.            to  send  the  facsimile.  By default, HylaFAX
  388.            will    redial 12 times    before killing a job.
  389.  
  390.        --UU _v_o_i_c_e_-_n_o Pass    _v_o_i_c_e_-_n_o to the     _f_a_x_c_o_v_e_r(1)  program  as
  391.            the sender's    voice number.
  392.  
  393.        --VV _v_o_i_c_e_-_n_o Pass     _v_o_i_c_e_-_n_o  to  the _f_a_x_c_o_v_e_r(1) program as
  394.            the destination person's voice number.
  395.  
  396.        --ww       Wait    for the    job to complete    before ending the
  397.            sendfax  session.  If this option is    used, the
  398.            sendfax process will    not terminate  until  the
  399.            job is completed.
  400.  
  401.        --WW _f_a_x_-_n_o   Pass     _f_a_x_-_n_o    to the _f_a_x_c_o_v_e_r(1) program as the
  402.            sender's fax    number.
  403.  
  404.        --xx _c_o_m_p_a_n_y  Pass    _c_o_m_p_a_n_y    to the _f_a_x_c_o_v_e_r(1) program as the
  405.            destination company name.
  406.  
  407.        --XX _c_o_m_p_a_n_y  Pass    _c_o_m_p_a_n_y    to the _f_a_x_c_o_v_e_r(1) program as the
  408.            sender's company name.
  409.  
  410.        --yy _l_o_c_a_t_i_o_n Pass    _l_o_c_a_t_i_o_n to the     _f_a_x_c_o_v_e_r(1)  program  as
  411.            the destination company's location.
  412.  
  413.        --YY _l_o_c_a_t_i_o_n Pass     _l_o_c_a_t_i_o_n  to  the _f_a_x_c_o_v_e_r(1) program as
  414.            the sender's    company    location.
  415.  
  416.        --vv       Print information on    the standard output about
  417.            each     conversion  and  cover     sheet generation
  418.            operation it    does.  If --vv is    specified  twice,
  419.            the    protocol  between  _s_e_n_d_f_a_x  and    the _h_f_a_x_d
  420.            server process that does the     submission  work
  421.            on the remote machine is also displayed.
  422.  
  423. CCOONNFFIIGGUURRAATTIIOONN PPAARRAAMMEETTEERRSS
  424.        _s_e_n_d_f_a_x    reads  configuration  information  from    the files
  425.        $${{LLIIBBDDAATTAA}}//hhffaaxxdd..ccoonnff,     $${{LLIIBBDDAATTAA}}//hhyyllaa..ccoonnff,       $${{LLIIBB
  426.        DDAATTAA}}//sseennddffaaxx..ccoonnff,  and     ~~//..hhyyllaarrcc;  in     that order, with
  427.        later-read settings superceding any  that  may  have  been
  428.        previously  read.   Configuration files follow the conven
  429.        tions described in _h_y_l_a_f_a_x_-_c_l_i_e_n_t(1).  The following  con
  430.        figuration  parameters  are recognized.    Parameters marked
  431.        with  are not available in ${LIBDATA}/hfaxd.conf    :
  432.        TTaagg        TTyyppee       DDeeffaauulltt    DDeessccrriippttiioonn
  433.        AutoCoverPage    boolean       Yes        automatically generate cover page
  434.        ChopThreshold    float       3.0        page chopping threshold
  435.        CoverCmd        string       _s_e_e _b_e_l_o_w    pathname of cover sheet    program
  436.        Cover-Comments    string       -        cover page comments string
  437.        Cover-Company   string      -           cover page to-company name string
  438.        Cover-Location  string      -           cover page to-company location string
  439.        Cover-Regarding    string       -        cover page regarding string
  440.        Cover-Template    string       -        cover page template filename
  441.        Cover-Voice     string      -           cover page to-voice number string
  442.        Cover-From-Company      string       -cover page from-company    string
  443.        Cover-From-Location      string       -cover page from-location string
  444.        Cover-From-Voice          string       -cover page from-voice number string
  445.        Cover-From-Fax  string      -           cover page from-fax number string
  446.        DateFormat    string       -        cover page date    format string
  447.        DesiredEC    boolean       -        desired    use of ECM
  448.        DesiredMST    string       -        desired    minimum    scanling time to use
  449.        DesiredSpeed    integer       -        desired    signalling rate    to use
  450.        DialRules    string       _s_e_e _b_e_l_o_w    file containing    dialstring rules
  451.        From        string       -        sender's identity
  452.        HRes        float       204.        horizontal resolution
  453.        Host        string       localhost    host to    contact    for service
  454.        KillTime        string       -        time to    expire job
  455.        MailAddr        string       -        mail address for notification messages
  456.        MaxDials        integer       12        times to retry dialing
  457.        MaxTries        integer       3        times to retry transmission
  458.        MinSpeed        integer       -        minimum    acceptable signalling rate
  459.        Modem        string       -        modem to use on    server
  460.        Notify        string       none        control    email notification
  461.        PageChop        string       default    control    page chop handling
  462.        PageLength    float       -        page length in millimeters
  463.        PageSize        string       default    page size by name
  464.        PageWidth    float       -        page width in millimeters
  465.        Port        integer       4559        port to    use in contacting server
  466.        Priority        string       default    job scheduling priority
  467.        Protocol        string       tcp        protocol to use    in contacting server
  468.        RetryTime    string       -        delay between failed attempts to send
  469.        SendTime        string       -        time to    send job
  470.        TagLine        string       -        tagline    format string
  471.        TypeRules    string       _s_e_e _b_e_l_o_w    file containing    file typing rules
  472.        VRes        float       98.        vertical resolution
  473.        Verbose        boolean       No        whether    or not to enable protocol tracing
  474.  
  475.        The configuration parameters are    explained below.  Certain
  476.        configuration   parameters,   notably  those  for  setting
  477.        strings    on  automatically  generated  cover  pages,   are
  478.        defined    mainly    for  use  by  other _H_y_l_a_F_A_X programs that
  479.        share common code used by _s_e_n_d_f_a_x.
  480.  
  481.        AAuuttooCCoovveerrPPaaggee   Control whether or not  a  cover     page  is
  482.                automatically   generated  for  each  job.
  483.                (Equivalent to the --nn option.)
  484.  
  485.        CChhooppTThhrreesshhoolldd   The amount of white space, in inches, that
  486.                must  be     present  at the bottom    of a page
  487.                before _H_y_l_a_F_A_X will  attempt  to     truncate
  488.                the page    transmission.
  489.  
  490.        CCoovveerrCCmmdd           The  absolute  pathname    of the program to
  491.                use to generate cover pages.  The  default
  492.                cover sheet program is $${{BBIINN}}//ffaaxxccoovveerr.
  493.  
  494.        CCoovveerr--CCoommmmeennttss  The  comments  string to    pass to    the cover
  495.                sheet program when  auto-generating  cover
  496.                pages.
  497.  
  498.        CCoovveerr--CCoommppaannyy   The  to-company name string to pass to the
  499.                cover sheet program  when  auto-generating
  500.                cover pages.
  501.  
  502.        CCoovveerr--LLooccaattiioonn  The  to-company location    string to pass to
  503.                the cover sheet program when auto-generat
  504.                ing cover pages.
  505.  
  506.        CCoovveerr--RReeggaarrddiinngg The  regarding string to    pass to    the cover
  507.                sheet program when  auto-generating  cover
  508.                pages.
  509.  
  510.        CCoovveerr--TTeemmppllaattee  The  absolute  pathname    of  a cover sheet
  511.                template    file to     use  in  auto-generating
  512.                cover pages.
  513.  
  514.        CCoovveerr--VVooiiccee     The  to-voice number string to pass to the
  515.                cover sheet program  when  auto-generating
  516.                cover pages.
  517.  
  518.        CCoovveerr--FFrroomm--CCoommppaannyy
  519.                The  from-company  name    string to pass to
  520.                the cover sheet program when auto-generat
  521.                ing cover pages.
  522.  
  523.        CCoovveerr--FFrroomm--LLooccaattiioonn
  524.                The  from-location  string  to pass to the
  525.                cover sheet program  when  auto-generating
  526.                cover pages.
  527.  
  528.        CCoovveerr--FFrroomm--VVooiiccee
  529.                The  from-voice    number    string to pass to
  530.                the cover sheet program when auto-generat
  531.                ing cover pages.
  532.  
  533.        CCoovveerr--FFrroomm--FFaaxx  The  from-fax number string to pass to the
  534.                cover sheet program  when  auto-generating
  535.                cover pages.
  536.  
  537.        DDaatteeFFoorrmmaatt      The  _s_t_r_f_t_i_m_e(3)     format    string to pass to
  538.                the cover page command when  auto-generat
  539.                ing cover pages.
  540.  
  541.        DDeessiirreeddEECC       Whether    or  not    to request the use of the
  542.                optional    Error  Correct    Mode  (ECM)  when
  543.                transmitting  facsimile.      (Equivalent  to
  544.                the --EE option.)
  545.  
  546.        DDeessiirreeddMMSSTT      The desired minimum scanline time  to  use
  547.                when  transmitting facsimile.  (Equivalent
  548.                to the --MM option.)
  549.  
  550.        DDeessiirreeddSSppeeeedd    The desired signalling  rate  to     the  use
  551.                when  transmitting facsimile.  (Equivalent
  552.                to the --BB option.)
  553.  
  554.        DDiiaallRRuulleess       The name    of the file containing the  dial
  555.                string  processing rules    to when    preparing
  556.                an externally  visible  representation  of
  557.                the  dialstring (e.g. to    strip credit card
  558.                numbers).   By  default    this  is   ${LIB
  559.                DATA}/dialrules.
  560.  
  561.        FFrroomm           The sender's identity.  (Equivalent to the
  562.                --ff option.)
  563.  
  564.        HHoosstt           The host    to contact for service.     (Equiva
  565.                lent to the --hh option.)
  566.  
  567.        HHRReess           The  horizontal    resolution  to    use  when
  568.                transmitting facsimile.     (NB:  _t_h_i_s  _c_u_r_
  569.                _r_e_n_t_l_y _h_a_s _n_o _e_f_f_e_c_t.)
  570.  
  571.        KKiillllTTiimmee           The expiration time to assign to    each job.
  572.                (Equivalent to the --kk option.)
  573.  
  574.        MMaaiillAAddddrr           The  electronic    mail  address  to  direct
  575.                notification messages from the server.  If
  576.                this  string  is     specified   without   an
  577.                ``@hostname'' part then the local hostname
  578.                will automatically be appended.     (Equiva
  579.                lent to the --ff option.)
  580.  
  581.        MMaaxxDDiiaallss           The  maximum  number  of    times to dial the
  582.                phone for each job.  (Equivalent    to the --TT
  583.                option.)
  584.  
  585.        MMaaxxTTrriieess           The maximum number of times to retry send
  586.                ing a job.  (Equivalent to the --tt option.)
  587.  
  588.        MMiinnSSppeeeedd           The  minimum acceptable signalling rate to
  589.                use when    transmitting facsimile.     (Equiva
  590.                lent to the --bb option.)
  591.  
  592.        MMooddeemm           The  modem to use on the    server.     (Equiva
  593.                lent to the --hh option.)
  594.  
  595.        NNoottiiffyy           Control the  email  notification     messages
  596.                from  the  server.  This    string may be one
  597.                of  ``done'',  ``none'',     ``requeued''  or
  598.                ``default''  with  an optionally    preceding
  599.                ``when '' (e.g. ``when done'').    Note that
  600.                ``when  requeued''  implies ``when done''.
  601.                (Equivalent  to    the  --DD,   --RR,     and   --NN
  602.                options.)
  603.  
  604.        PPaaggeeCChhoopp           Control    page chop handling when    transmit
  605.                ting facsimile.    This string may    be one of
  606.                ``none'',  ``all'',  or ``last' to have no
  607.                pages chopped, all pages    chopped, or  only
  608.                the last    page chopped; respectively.  Page
  609.                chopping    is controlled by the  CChhooppTThhrreesshh
  610.                oolldd parameter.
  611.  
  612.        PPaaggeeLLeennggtthh      Set  the     transmitted  page length in mil
  613.                limeters.
  614.  
  615.        PPaaggeeSSiizzee           Set the page dimensions    according  to  an
  616.                entry   in   the      _p_a_g_e_s_i_z_e_s(${MANNUM4_5})
  617.                database.  (Equivalent to the --ss     option.)
  618.  
  619.        PPaaggeeWWiiddtthh       Set the transmitted page    width in millime
  620.                ters.
  621.  
  622.        PPoorrtt           The network port    to contact  for     service.
  623.                (Eqvuialent to the --hh option.)
  624.  
  625.        PPrriioorriittyy           The  scheduling priority    to assign to each
  626.                job.  (Equivalent to the    --PP option.)
  627.  
  628.        PPrroottooccooll           The name    of the communication protocol  to
  629.                use when    contacting a server.  (Equivalent
  630.                to the FFAAXXSSEERRVVIICCEE environment variable.)
  631.  
  632.        RReettrryyTTiimmee       The time    to delay between job retries  due
  633.                to  a  communication failure.  (Equivalent
  634.                to the --II option.)
  635.  
  636.        SSeennddTTiimmee           The time    to send    jobs.  (Equivalent to the
  637.                --aa option.)
  638.  
  639.        TTaaggLLiinnee           The  tagline  format  string  to     use when
  640.                transmitting  facsimile.      (Equivalent  to
  641.                the --FF option.)
  642.  
  643.        TTyyppeeRRuulleess       The  name of the    file containing    file type
  644.                conversion  rules.   By    default     this  is
  645.                ${LIBDATA}/typerules.
  646.  
  647.        VVeerrbboossee           Control    protocol tracing.  (Equivalent to
  648.                the --vvvv option.)
  649.  
  650.        VVRReess           Set the vertical    resolution in  lines/inch
  651.                to   use      when     transmitting  facsimile.
  652.                (Equivalent to the --mm and --ll options.)
  653.  
  654. DDIIAAGGNNOOSSTTIICCSS
  655.        The following messages are generated because  of     problems
  656.        encountered on the local    machine.
  657.  
  658.        CCoouulldd nnoott ccaallll sseerrvveerr..  The facsimile server on the remote
  659.        machine did not respond.
  660.  
  661.        NNoo iinnppuutt    ddaattaa;; ttrraannmmiissssiioonn aabboorrtteedd..  No data was     supplied
  662.        (typically  on  the standard input).  No    facsimile will be
  663.        sent.
  664.  
  665.        EErrrroorr ccoonnvveerrttiinngg    ddaattaa;; ccoommmmaanndd wwaass  %%ss..""     A  data  conver
  666.        sion  operation failed; the shell command that was used is
  667.        printed.
  668.  
  669.        CCaann nnoott ccoonnvveerrtt %%ss..   Data  needed  to  be  converted  for
  670.        transmission,  but  the    required  conversion rule was not
  671.        located.     This may indicate that    the _H_y_l_a_F_A_X software  was
  672.        incorrectly  installed;    or  perhaps  that  an NFS-mounted
  673.        directory is temporarily    unavailable.
  674.  
  675.        %%ss:: CCaann nnoott ddeetteerrmmiinnee ffiillee ttyyppee..     _s_e_n_d_f_a_x  was  unable  to
  676.        deduce the type of the file.
  677.  
  678.        %%ss::  NNoott    aa rreegguullaarr ffiillee..     The file is something other than
  679.        a regular file; for example, a directory.
  680.  
  681.        The following messages may be printed by     _s_e_n_d_f_a_x.   These
  682.        messages     describe problems encountered by the server pro
  683.        cess on the remote  machine.   This  list  is  incomplete;
  684.        other  messages    may  be     generated  by    the  server under
  685.        unusual circumstances.
  686.  
  687. FFIILLEESS
  688.        ~/.hylarc          per-user configuration file
  689.        ${LIBDATA}/hyla.conf      system-wide configuration file
  690.        ${LIBDATA}/sendfax.conf      system-wide configuration file
  691.        ${LIBDATA}/typerules      file type and    conversion rules
  692.        ${LIBDATA}/pagesizes      page size database
  693.        ${LIBDATA}/dialrules      optional client dialstring rules
  694.        ${BIN}/faxcover          for generating cover sheets
  695.        ${LIBEXEC}/textfmt      for converting text to PostScript
  696.        ${LIBEXEC}/sgi2fax      for converting SGI RGB images
  697.        ${SPOOL}/tmp/sndfaxXXXXXX  temporary files
  698.  
  699. SSEEEE AALLSSOO
  700.        _a_t(1), _h_y_l_a_f_a_x_-_c_l_i_e_n_t(1), _f_a_x_a_l_t_e_r(1),  _f_a_x_c_o_v_e_r(1),  _f_a_x_
  701.        _m_a_i_l(1),     _f_a_x_r_m(1),  _f_a_x_s_t_a_t(1),     _s_g_i_2_f_a_x(1),  _t_e_x_t_f_m_t(1),
  702.        _h_f_a_x_d(${MANNUM1_8}), _h_y_l_a_f_a_x_-_s_e_r_v_e_r(${MANNUM4_5}),  _t_y_p_e_r_
  703.        _u_l_e_s(${MANNUM4_5})
  704.  
  705.  
  706.  
  707.              January 06, 2001           SENDFAX(1)
  708.